home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / PROTO212.ARJ / README < prev    next >
Text File  |  1992-01-24  |  7KB  |  195 lines
  1.     This version of the prototype extractor is a shareware. It is
  2.     not a complete version. Solucorp provides this program for
  3.     evaluation. The user has 30 days to evaluate it. When users
  4.     pay a fee (currently 25$ US or 30$ canadian), they receive a
  5.     full copy plus several utilities. Together they form the
  6.     "Solucorp's programmer toolkit" .
  7.  
  8.     The user receives DOS, XENIX (for 386/486 computers) and SUN SPARC
  9.     versions of the kit. The registration number allows the user to
  10.     order any future updates of the kit for a nominal fee of 10$ per update.
  11.  
  12.     Here follows a description of the utilities. The file example.zip
  13.     gives a more complete coverage of the capabilities of those utilities.
  14.     Solucorp reserves rights to change content of the kit without
  15.     notice.
  16.  
  17.  
  18.     -Dircmd: An enhanced file find utility.
  19.     -Make: An enhance make utility.
  20.     -Makedep: A dependancy builder for makefiles.
  21.     -Naloc: A function browser.
  22.     -Naperm: Sorted indexes builder.
  23.     -Nadoc: Formatter for systems documentation.
  24.     -Nulfct: Strip some function calls from a source file.
  25.  
  26. Dircmd: An enhanced file find utility.
  27.  
  28.     Dircmd not only locates files and directories using complex
  29.     selection criteria (date, multiple wildcard, exclusion, directory
  30.     mirroring, etc ...), but let you apply command on it.
  31.  
  32.     The following command deletes every .obj file associated
  33.     to a .c file on a disk.
  34.  
  35.     dircmd -s -e *.c del %p%\%b.obj
  36.  
  37.     This will delete each file that appears both in directory
  38.     archive and work and are the same (same size, same date).
  39.     dircmd -c+=\archive -e \work\*.* del %s
  40.  
  41.     Essential for large disk and network management.
  42.  
  43. Make: An enhance make utility.
  44.  
  45.     Solucorp Make introduces several extensions. It allows for portable
  46.     makefiles between UNIX and DOS. Here are a list of enhancements from
  47.     standard Makes. See the file makefile in example.zip.
  48.  
  49.    -Overcome DOS command line limitation.
  50.  
  51.     DOS limits command line to 126 characters. Make solves this problem
  52.     almost transparently.
  53.  
  54.    -Overcome DOS 640K limits.
  55.  
  56.     Make can either swap itself to disk or open a separate DesqView
  57.     window, leaving most memory available.
  58.  
  59.    -Conditionnal processing.
  60.  
  61.     Make supports a complete set of preprocessor directives that
  62.     works much like the C preprocessor.
  63.  
  64.    -Distributed project.
  65.  
  66.     Make can operate transparently with source files and object
  67.     files distributed in several different directories. The exact
  68.     disposition is independant of the rules themselves. This yields
  69.     "transportable" makefiles.
  70.  
  71.    -Enhanced macro definition syntax.
  72.  
  73.     Supports definitions using wildcards. Supports exclusion.
  74.  
  75.    -Powerfull macro editing capability.
  76.  
  77.     Once a macro is defined, it can be used as is, or used with
  78.     modifications.
  79.  
  80.    -Automatic handling of include files dependancies. See utility makedep.
  81.  
  82.    -Enhanced selective touch option.
  83.  
  84.     A touch may be applied on targets outdated by only
  85.     a specified dependancy.
  86.  
  87.    -Debugging option that lets you inspect the decision tree.
  88.  
  89. Makedep: A dependancy builder for makefiles.
  90.  
  91.     Makedep scans a list of source files, and produced a "parallel" file
  92.     used transparently by make. It tells Make the depandencies
  93.     between sources and header files. You don't have to update
  94.     yourself the makefile anymore each time you include a different
  95.     header in a source.
  96.  
  97. Naloc: A function browser.
  98.  
  99.     Naloc locates the source file holding a function declaration
  100.     anywhere in a multiple sources, multiple directories project.
  101.     Easily hooked to any programmable editor.
  102.  
  103. Naperm: Sorted indexes builder.
  104.  
  105.     This programs produced three output files: A summary, a permutted
  106.     index and a log of the revision made to a package. See document.exm
  107.     in example.zip.
  108.  
  109. Nadoc: Formatter for systems documentation.
  110.  
  111.     Nadoc lets you write the outline of a system documentation. You
  112.     simply identify the sections and sub-sections, briefly introduce
  113.     each  one and then identify which functions belong to which sections.
  114.     Nadoc automaticly creates a document by extracting the documentation
  115.     from the sources. It creates a table of contents. It points out
  116.     the functions not mentionned in the document and obsolete functions.
  117.  
  118.     A must for code reuse. See file document.exm in example.zip.
  119.  
  120. Nulfct: Strip some function call from a source file.
  121.  
  122.     Given a list of function (generally debugging function), nulfct
  123.     will strip every call made to those functions and will produce
  124.     a temporary file, leaving the original untouched. This file may then
  125.     be compiled.
  126.  
  127.  
  128. --------------------------------------------------------------------
  129.  
  130.     New feature of utility proto. These are extracts from
  131.     the manual profoe.man.
  132.  
  133. --------------------------------------------------------------------
  134. 1       Introduction and warnings
  135.  
  136.   The prototype extractor automates part of an ANSI C and C++ 
  137.   2.0 programmer's work. It also supports K&R functions 
  138.   declaration syntax. 
  139.  
  140.   This utility is available for both MSDOS(PCDOS) (3.0 and 
  141.   up), SCO XENIX version 2.3 (UNIX système V.3.2) et SUN SPARC 
  142.   (Sunos). 
  143.  
  144.   This manual applies to all three systems. However, the / 
  145.   field separator has been used for file specification. The 
  146.   MSDOS version used the \ character instead. 
  147.  
  148. 3.3     Added keyword to automate operation of the extractor
  149.  
  150.   C++ and C do not allow fully automatic prototype extraction. 
  151.   They are missing keywords for access control. The extractor 
  152.   need specific information to distribute properly prototypes 
  153.   in header files. 
  154.  
  155.   The extractor supports seven special keywords. 
  156.  
  157.       export      C et C++
  158.       _export     C et C++
  159.       PRIVATE     C++
  160.       PUBLIC      C++
  161.       PROTECTED   C++
  162.       STATIC      C++
  163.       VIRTUAL     C++
  164.  
  165. 3.4.3   -b : Update C++ header file from a .pm file
  166.  
  167.   Normally, proto output all class member function prototypes 
  168.   in a single file (see option -m0+, -m1+ and -c+). This file 
  169.   generally has the extension ".pm". From this file, proto 
  170.   distributes prototypes of class member functions in the 
  171.   header files that hold class definition. Option -b triggers 
  172.   this distribution. 
  173.  
  174.   The syntax goes like this: 
  175.  
  176.       -bheader_file+pm_file=destination_file
  177.       -bheader_file+pm_file
  178.       -bheader_file
  179.       -b
  180.  
  181.   If destination_file is omitted, header_file is used. If 
  182.   pm_file is omitted X.pm is used (where X is the name of the 
  183.   current directory). Option -b without argument is equivalent 
  184.   to -bX.hpp+X.pm or -bX.h+X.pm where X is the name of the 
  185.   current directory. X.h is used when X.hpp does not exist. 
  186.  
  187.   Option -b may be used several times (to update different 
  188.   headers) on the same command line. Its action will be 
  189.   triggered only after the last prototype has been extracted. 
  190.  
  191. 3.4.15  -o : Alternative name for option -m
  192.  
  193.   Option -m builds its output files from the current directory 
  194.   name. Option -o let you specify another base name. 
  195.